pypureclient.flashblade.FB_2_17.api package

Submodules

pypureclient.flashblade.FB_2_17.api.active_directory_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.active_directory_api.ActiveDirectoryApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_active_directory_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_only: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE active-directory # noqa: E501

Delete an Active Directory account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_active_directory_delete_with_http_info(x_request_id, ids, local_only, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • local_only (bool) – If specified as true, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to false.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_active_directory_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET active-directory # noqa: E501

List Active Directory accounts and their configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_active_directory_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_active_directory_patch_with_http_info(active_directory: ActiveDirectoryPatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH active-directory # noqa: E501

Modify the configuration of an Active Directory account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_active_directory_patch_with_http_info(active_directory, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • active_directory (ActiveDirectoryPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryResponse, status_code(int), headers(HTTPHeaderDict))

api217_active_directory_post_with_http_info(active_directory: ActiveDirectoryPost, x_request_id: Optional[StrictStr] = None, join_existing_account: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST active-directory # noqa: E501

Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_active_directory_post_with_http_info(active_directory, x_request_id, join_existing_account, names, async_req=True)
>>> result = thread.get()
Parameters

  • active_directory (ActiveDirectoryPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • join_existing_account (bool) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining to a pre-existing account must have permissions to ‘read attributes from’ and ‘reset the password of’ the pre-existing account. service_principal_names, encryption_types, and join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryResponse, status_code(int), headers(HTTPHeaderDict))

api217_active_directory_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET active-directory/test # noqa: E501

Testing if the configuration of an Active Directory account is valid. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_active_directory_test_get_with_http_info(x_request_id, filter, ids, limit, names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.administrators_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.administrators_api.AdministratorsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_admins_api_tokens_delete_with_http_info(x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE admins/api-tokens # noqa: E501

Deletes the API tokens of the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_api_tokens_delete_with_http_info(x_request_id, admin_ids, admin_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • admin_ids (List[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

  • admin_names (List[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_admins_api_tokens_get_with_http_info(x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET admins/api-tokens # noqa: E501

Displays API tokens for the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_api_tokens_get_with_http_info(x_request_id, admin_ids, admin_names, continuation_token, expose_api_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • admin_ids (List[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

  • admin_names (List[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • expose_api_token (bool) – If true, exposes the API token of the current user.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminApiTokenGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_api_tokens_post_with_http_info(x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, timeout: Optional[StrictInt] = None, **kwargs) → ApiResponse

POST admins/api-tokens # noqa: E501

Creates API tokens for the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_api_tokens_post_with_http_info(x_request_id, admin_ids, admin_names, timeout, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • admin_ids (List[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

  • admin_names (List[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

  • timeout (int) – The duration of API token validity, in milliseconds.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminApiTokenResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_cache_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE admins/cache # noqa: E501

Delete cached administrator role information by name or ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_cache_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_admins_cache_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, refresh: Optional[StrictBool] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET admins/cache # noqa: E501

List cached administrator information used to determine role based access control privileges. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_cache_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, refresh, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • refresh (bool) – Whether to refresh the user info from directory service. If not specified, defaults to false.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminCacheGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE admins # noqa: E501

Delete a local administrator.. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_admins_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET admins # noqa: E501

List the administrator’s attributes, including the API token and public key. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_get_with_http_info(x_request_id, continuation_token, expose_api_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • expose_api_token (bool) – If true, exposes the API token of the current user.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_patch_with_http_info(admin: AdminPatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH admins # noqa: E501

Modify the attributes of an administrator. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_patch_with_http_info(admin, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • admin (AdminPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_post_with_http_info(admin: AdminPost, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST admins # noqa: E501

Create a new local administrator. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_post_with_http_info(admin, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • admin (AdminPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_settings_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List global admin settings # noqa: E501

Return global admin settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_settings_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_settings_patch_with_http_info(admin_setting: AdminSetting, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Update global admin settings # noqa: E501

Update properties for global admin settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_settings_patch_with_http_info(admin_setting, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • admin_setting (AdminSetting) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminSettingsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.alert_watchers_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.alert_watchers_api.AlertWatchersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_alert_watchers_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE alert-watchers # noqa: E501

Delete an alert watcher. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alert_watchers_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_alert_watchers_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET alert-watchers # noqa: E501

List alert watchers that are configured to receive alert messages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alert_watchers_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_alert_watchers_patch_with_http_info(alert_watcher: AlertWatcher, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH alert-watchers # noqa: E501

Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege and select the level of alert notification of an alert watcher. Alert notification levels are info, warning, or critical. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alert_watchers_patch_with_http_info(alert_watcher, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • alert_watcher (AlertWatcher) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api217_alert_watchers_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, alert_watcher: Optional[AlertWatcherPost] = None, **kwargs) → ApiResponse

POST alert-watchers # noqa: E501

Create an alert watcher to receive array alert messages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alert_watchers_post_with_http_info(names, x_request_id, alert_watcher, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • alert_watcher (AlertWatcherPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api217_alert_watchers_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET alert-watchers/test # noqa: E501

Test an alert watcher’s contact information to verify alerts can be sent and received. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alert_watchers_test_get_with_http_info(x_request_id, filter, ids, names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.alerts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.alerts_api.AlertsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_alerts_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET alerts # noqa: E501

Returns a list of alerts which have been generated by the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alerts_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_alerts_patch_with_http_info(alerts_settings: Alert, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH alerts # noqa: E501

Make changes to an alert. This is currently limited to the alert’s flagged property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_alerts_patch_with_http_info(alerts_settings, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • alerts_settings (Alert) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.api_clients_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.api_clients_api.APIClientsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_api_clients_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE api-clients # noqa: E501

Delete the API client. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_api_clients_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_api_clients_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET api-clients # noqa: E501

List an API client and its configuration attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_api_clients_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientsResponse, status_code(int), headers(HTTPHeaderDict))

api217_api_clients_patch_with_http_info(api_clients: ApiClient, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH api-clients # noqa: E501

Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_api_clients_patch_with_http_info(api_clients, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • api_clients (ApiClient) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientsResponse, status_code(int), headers(HTTPHeaderDict))

api217_api_clients_post_with_http_info(api_client: ApiClientsPost, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST api-clients # noqa: E501

Create an API client to authorize Access Token or Bearer Tokens for use on the array. Required fields include issuer, public_key, and access_token_ttl_in_ms. After creating an API client, it can only be enabled by an authorized user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_api_clients_post_with_http_info(api_client, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • api_client (ApiClientsPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.array_connections_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.array_connections_api.ArrayConnectionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_array_connections_connection_key_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET array-connections/connection-key # noqa: E501

List connection keys used to authenticate the connection from one array to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_connection_key_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_connection_key_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST array-connections/connection-key # noqa: E501

Create an array connection key allowing one array to connect to another for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_connection_key_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionKeyResponse, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE array-connections # noqa: E501

Delete a connection to an array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_delete_with_http_info(x_request_id, context_names, ids, remote_ids, remote_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections with ids. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. Deprecated, best practice is to reference connections with ids. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_array_connections_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET array-connections # noqa: E501

List connected arrays for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, offset, remote_ids, remote_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_patch_with_http_info(array_connection: ArrayConnection, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH array-connections # noqa: E501

Modify the configuration of a connected array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_patch_with_http_info(array_connection, x_request_id, context_names, ids, remote_ids, remote_names, async_req=True)
>>> result = thread.get()
Parameters

  • array_connection (ArrayConnection) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections with ids. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. Deprecated, best practice is to reference connections with ids. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionResponse, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_path_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET array-connections/path # noqa: E501

List network path details of connected arrays. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_path_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, offset, remote_ids, remote_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionPathGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_performance_replication_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, type: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET array-connections/performance/replication # noqa: E501

List performance metrics of file systems or objects being replicated from one array to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_performance_replication_get_with_http_info(x_request_id, continuation_token, end_time, filter, ids, limit, offset, remote_ids, remote_names, resolution, sort, start_time, total_only, type, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • type (str) – Display the metric of a specified object type. Valid values are all, file-system, and object-store. If not specified, defaults to all.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ConnectionRelationshipPerformanceReplicationGetResp, status_code(int), headers(HTTPHeaderDict))

api217_array_connections_post_with_http_info(array_connection: ArrayConnectionPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST array-connections # noqa: E501

Create a connection to an array for replication and configure network settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_array_connections_post_with_http_info(array_connection, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • array_connection (ArrayConnectionPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.arrays_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.arrays_api.ArraysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_arrays_eula_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET arrays/eula # noqa: E501

List the End User Agreement and signature. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_eula_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(EulaGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_eula_patch_with_http_info(x_request_id: Optional[StrictStr] = None, eula: Optional[Eula] = None, **kwargs) → ApiResponse

PATCH arrays/eula # noqa: E501

Modifies the signature on the End User Agreement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_eula_patch_with_http_info(x_request_id, eula, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • eula (Eula) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(EulaResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_factory_reset_token_delete_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete a factory reset token # noqa: E501

Deletes any existing token that could be used to perform a factory reset on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_factory_reset_token_delete_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_arrays_factory_reset_token_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List factory reset tokens # noqa: E501

Displays a list of tokens used to perform a factory reset on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_factory_reset_token_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayFactoryResetTokenGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_factory_reset_token_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a factory reset token # noqa: E501

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled until all tokens have been deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_factory_reset_token_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayFactoryResetTokenResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET arrays # noqa: E501

List array attributes such as the array name, ID, version, and NTP servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_http_specific_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

GET arrays/http-specific-performance # noqa: E501

List the HTTP performance metrics of the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_http_specific_performance_get_with_http_info(x_request_id, allow_errors, context_names, end_time, resolution, start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayHttpSpecificPerformanceGet, status_code(int), headers(HTTPHeaderDict))

api217_arrays_nfs_specific_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

GET arrays/nfs-specific-performance # noqa: E501

List the NFS performance metrics of the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_nfs_specific_performance_get_with_http_info(x_request_id, allow_errors, context_names, end_time, resolution, start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayNfsSpecificPerformanceGet, status_code(int), headers(HTTPHeaderDict))

api217_arrays_patch_with_http_info(array: Array, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH arrays # noqa: E501

Modify the general configuration of the array including banner text, array name, NTP servers, and time zone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_patch_with_http_info(array, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • array (Array) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

GET arrays/performance # noqa: E501

Lists the overall performance metrics of the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_performance_get_with_http_info(x_request_id, allow_errors, context_names, end_time, protocol, resolution, start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • protocol (str) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_performance_replication_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, type: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET arrays/performance/replication # noqa: E501

List replication performance metrics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_performance_replication_get_with_http_info(x_request_id, allow_errors, context_names, end_time, resolution, start_time, type, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • type (str) – Display the metric of a specified object type. Valid values are all, file-system, and object-store. If not specified, defaults to all.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayPerformanceReplicationGetResp, status_code(int), headers(HTTPHeaderDict))

api217_arrays_s3_specific_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

GET arrays/s3-specific-performance # noqa: E501

List the S3 performance metrics of the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_s3_specific_performance_get_with_http_info(x_request_id, allow_errors, context_names, end_time, resolution, start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayS3SpecificPerformanceGetResp, status_code(int), headers(HTTPHeaderDict))

api217_arrays_space_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, type: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET arrays/space # noqa: E501

List available and used storage space on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_space_get_with_http_info(x_request_id, allow_errors, context_names, end_time, resolution, start_time, type, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • type (str) – Display the metric of a specified object type. Valid values are array, file-system, and object-store. If not specified, defaults to array.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArraySpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_space_storage_classes_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, storage_class_names: Optional[ConstrainedListValue[StrictStr]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET arrays/space/storage-classes # noqa: E501

List available and used storage space for storage classes on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_space_storage_classes_get_with_http_info(x_request_id, continuation_token, end_time, filter, limit, offset, resolution, sort, start_time, storage_class_names, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • storage_class_names (List[str]) – A comma-separated list of storage class names. Valid values include S500X-S and S500X-A.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArraySpaceStorageClassGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_supported_time_zones_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET arrays/supported-time-zones # noqa: E501

List supported time zones for the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_supported_time_zones_get_with_http_info(x_request_id, continuation_token, filter, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArraysSupportedTimeZonesGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.audits_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.audits_api.AuditsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_audits_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET audits # noqa: E501

List the array audit trail to view activities that were performed on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audits_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.authorization_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.authorization_api.AuthorizationApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api_api_version_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET api_version # noqa: E501

Get available API versions. No authentication is required to access this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api_api_version_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiVersion, status_code(int), headers(HTTPHeaderDict))

api_login_banner_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET login_banner # noqa: E501

Get the login banner for the array. No authentication is required to access this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api_login_banner_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LoginBannerGetResponse, status_code(int), headers(HTTPHeaderDict))

api_login_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST login # noqa: E501

Exchange an API token for a REST session token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api_login_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Login, status_code(int), headers(HTTPHeaderDict))

api_logout_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST logout # noqa: E501

Invalidate a REST session token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api_logout_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

oauth210_token_post_with_http_info(grant_type: StrictStr, subject_token: StrictStr, subject_token_type: StrictStr, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Get access token # noqa: E501

Exchanges an ID Token for an OAuth 2.0 access token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.oauth210_token_post_with_http_info(grant_type, subject_token, subject_token_type, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • grant_type (str) – The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type, which indicates that a token exchange is being performed. Set grant_type to urn:ietf:params:oauth:grant-type:token-exchange. (required)

  • subject_token (str) – An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims: > | JWT claim | Location | API Client Field | Description | Required By | > |-|-|-|-|-| > | kid | Header | key_id | Key ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | aud | Payload | id | Client ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | sub | Payload | | Login name of the array user for whom the token should be issued. This must be a valid user in the system. | FlashArray and FlashBlade only. | > | iss | Payload | issuer | Application ID for the Pure1 or API client’s trusted identity issuer on the array. | All products. | > | iat | Payload | | Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. | All products. | > | exp | Payload | | Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. | All products. | Each token must also be signed with the private key that is paired with the API client’s public key. (required)

  • subject_token_type (str) – An identifier that indicates the type of security token specifed in the subject_token parameter. The Pure Storage REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set subject_token_type to urn:ietf:params:oauth:token-type:jwt. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OauthTokenResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.blades_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.blades_api.BladesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_blades_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET blades # noqa: E501

List array blade information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_blades_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BladeGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.buckets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.buckets_api.BucketsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_buckets_bucket_access_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE buckets/bucket-access-policies # noqa: E501

Delete a bucket policy of the specified bucket. Either names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_delete_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_buckets_bucket_access_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET buckets/bucket-access-policies # noqa: E501

List a policy for the specified bucket and its attributes. Either names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_get_with_http_info(x_request_id, allow_errors, bucket_ids, bucket_names, context_names, continuation_token, filter, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketAccessPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_bucket_access_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[BucketAccessPolicyPost] = None, **kwargs) → ApiResponse

POST buckets/bucket-access-policies # noqa: E501

Create a new policy for the specified bucket. Policy’s name will be autogenerated by the system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_post_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (BucketAccessPolicyPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketAccessPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_bucket_access_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE buckets/bucket-access-policies/rules # noqa: E501

Delete one or more bucket policy rules for the specified bucket. Either policy_names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_rules_delete_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, names, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_buckets_bucket_access_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET buckets/bucket-access-policies/rules # noqa: E501

List bucket policy rules for the specified bucket and their attributes. Either policy_names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_rules_get_with_http_info(x_request_id, allow_errors, bucket_ids, bucket_names, context_names, continuation_token, filter, limit, names, offset, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketAccessPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_bucket_access_policies_rules_post_with_http_info(names: ConstrainedListValue[StrictStr], rule: BucketAccessPolicyRulePost, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST buckets/bucket-access-policies/rules # noqa: E501

Create a new bucket policy rule for the specified bucket. Either policy_names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_bucket_access_policies_rules_post_with_http_info(names, rule, x_request_id, bucket_ids, bucket_names, context_names, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • rule (BucketAccessPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketAccessPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_cross_origin_resource_sharing_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE buckets/cross-origin-resource-sharing-policies # noqa: E501

Delete a cross origin resource sharing policy of the specified bucket. Either names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_delete_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_buckets_cross_origin_resource_sharing_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET buckets/cross-origin-resource-sharing-policies # noqa: E501

List cross origin resource sharing policy for the specified bucket and its attributes. Either names or bucket_names/bucket_ids query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_get_with_http_info(x_request_id, allow_errors, bucket_ids, bucket_names, context_names, continuation_token, filter, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CrossOriginResourceSharingPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_cross_origin_resource_sharing_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[CrossOriginResourceSharingPolicyPatch] = None, **kwargs) → ApiResponse

POST buckets/cross-origin-resource-sharing-policies # noqa: E501

Create a new cross origin resource sharing policy for the specified bucket. Policy’s name will be autogenerated by the system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_post_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (CrossOriginResourceSharingPolicyPatch) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CrossOriginResourceSharingPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_cross_origin_resource_sharing_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE buckets/cross-origin-resource-sharing-policies/rules # noqa: E501

Delete one or more cross origin resource sharing policy rules for the specified bucket. Either policy_names or bucket_names query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_rules_delete_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, names, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_buckets_cross_origin_resource_sharing_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET buckets/cross-origin-resource-sharing-policies/rules # noqa: E501

List cross origin resource sharing policy rules for the specified bucket and their attributes. Either policy_names or bucket_names query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_rules_get_with_http_info(x_request_id, allow_errors, bucket_ids, bucket_names, context_names, continuation_token, filter, limit, names, offset, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CrossOriginResourceSharingPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_cross_origin_resource_sharing_policies_rules_post_with_http_info(names: ConstrainedListValue[StrictStr], rule: CrossOriginResourceSharingPolicyRulePost, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST buckets/cross-origin-resource-sharing-policies/rules # noqa: E501

Create a new cross origin resource sharing policy rule for the specified bucket. Either policy_names or bucket_names query parameters can be used. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_cross_origin_resource_sharing_policies_rules_post_with_http_info(names, rule, x_request_id, bucket_ids, bucket_names, context_names, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • rule (CrossOriginResourceSharingPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CrossOriginResourceSharingPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE buckets # noqa: E501

Delete object store buckets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_buckets_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET buckets # noqa: E501

List object store bucket attributes such as creation time and space usage. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_patch_with_http_info(bucket: BucketPatch, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH buckets # noqa: E501

Modify object store bucket attributes such as destroyed and versioning. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_patch_with_http_info(bucket, x_request_id, context_names, ids, ignore_usage, names, async_req=True)
>>> result = thread.get()
Parameters

  • bucket (BucketPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET buckets/performance # noqa: E501

List performance metrics for a bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_performance_get_with_http_info(x_request_id, continuation_token, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_post_with_http_info(names: ConstrainedListValue[StrictStr], bucket: BucketPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST buckets # noqa: E501

Create a new object store bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_post_with_http_info(names, bucket, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • bucket (BucketPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketResponse, status_code(int), headers(HTTPHeaderDict))

api217_buckets_s3_specific_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET buckets/s3-specific-performance # noqa: E501

List performance metrics specific to S3 operations for a bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_buckets_s3_specific_performance_get_with_http_info(x_request_id, continuation_token, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(BucketS3SpecificPerformanceGetResp, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.certificate_groups_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.certificate_groups_api.CertificateGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_certificate_groups_certificates_delete_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE certificate-groups/certificates # noqa: E501

Delete one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_certificates_delete_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_certificate_groups_certificates_get_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificate-groups/certificates # noqa: E501

List membership associations between groups and certificates on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_certificates_get_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupCertificateGetResp, status_code(int), headers(HTTPHeaderDict))

api217_certificate_groups_certificates_post_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST certificate-groups/certificates # noqa: E501

Add one or more certificates to one or more certificate groups on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_certificates_post_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupCertificateResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificate_groups_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE certificate-groups # noqa: E501

Delete one or more certificate groups from the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_certificate_groups_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificate-groups # noqa: E501

Display all array certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificate_groups_post_with_http_info(x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST certificate-groups # noqa: E501

Create one or more certificate groups on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_post_with_http_info(x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificate_groups_uses_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificate-groups/uses # noqa: E501

List how certificate groups are being used and by what. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificate_groups_uses_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupUseGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.certificates_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.certificates_api.CertificatesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_certificates_certificate_groups_delete_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE certificates/certificate-groups # noqa: E501

Remove one or more certificates from one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_certificate_groups_delete_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_certificates_certificate_groups_get_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificates/certificate-groups # noqa: E501

List membership associations between groups and certificates. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_certificate_groups_get_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateCertificateGroupGetResp, status_code(int), headers(HTTPHeaderDict))

api217_certificates_certificate_groups_post_with_http_info(x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST certificates/certificate-groups # noqa: E501

Add one or more certificates to one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_certificate_groups_post_with_http_info(x_request_id, certificate_group_ids, certificate_group_names, certificate_ids, certificate_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

  • certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

  • certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

  • certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateCertificateGroupResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificates_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE certificates # noqa: E501

Delete a CA certificate from the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_certificates_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificates # noqa: E501

List array certificates and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificates_patch_with_http_info(certificate: CertificatePatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH certificates # noqa: E501

Modify SSL certificate attributes such as passphrases and intermediate certificates. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_patch_with_http_info(certificate, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • certificate (CertificatePatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificates_post_with_http_info(certificate: CertificatePost, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST certificates # noqa: E501

Upload a CA certificate to the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_post_with_http_info(certificate, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • certificate (CertificatePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateResponse, status_code(int), headers(HTTPHeaderDict))

api217_certificates_uses_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET certificates/uses # noqa: E501

List how certificates are being used and by what. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_certificates_uses_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateUseGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.clients_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.clients_api.ClientsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_arrays_clients_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET clients-performance # noqa: E501

List NFS client I/O performance metrics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_clients_performance_get_with_http_info(x_request_id, filter, limit, names, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ClientPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.directory_services_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.directory_services_api.DirectoryServicesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_directory_services_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET directory-services # noqa: E501

List directory service configuration information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_patch_with_http_info(directory_service: DirectoryService, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH directory-services # noqa: E501

Modifies and tests the directory service configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_patch_with_http_info(directory_service, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • directory_service (DirectoryService) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_roles_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE directory-service/roles # noqa: E501

Delete an RBAC group configuration setting for manageability. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_roles_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_directory_services_roles_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET directory-service/roles # noqa: E501

Return array’s RBAC group configuration settings for manageability. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_roles_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, role_ids, role_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the names, role_names, or role_ids query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of names, then an error is returned. This cannot be provided together with the ids, role_names, or role_ids query parameters.

  • offset (int) – The offset of the first resource to return from a collection.

  • role_ids (List[str]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, names or role_names query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role id, an error will be returned in order to avoid ambiguous operation.

  • role_names (List[str]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, names, or role_ids query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role name, an error will be returned in order to avoid ambiguous operation.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRolesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_roles_patch_with_http_info(directory_service_roles: DirectoryServiceRole, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH directory-service/roles # noqa: E501

Update an RBAC group configuration setting for manageability. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_roles_patch_with_http_info(directory_service_roles, x_request_id, ids, names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • directory_service_roles (DirectoryServiceRole) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the names, role_names, or role_ids query parameters.

  • names (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of names, then an error is returned. This cannot be provided together with the ids, role_names, or role_ids query parameters.

  • role_ids (List[str]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, names or role_names query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role id, an error will be returned in order to avoid ambiguous operation.

  • role_names (List[str]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, names, or role_ids query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role name, an error will be returned in order to avoid ambiguous operation.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRolesResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_roles_post_with_http_info(directory_service_roles: DirectoryServiceRole, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST directory-service/roles # noqa: E501

Create an RBAC group configuration setting for manageability. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_roles_post_with_http_info(directory_service_roles, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • directory_service_roles (DirectoryServiceRole) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRolesResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET directory-services/test # noqa: E501

Test the configured directory services on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_test_get_with_http_info(x_request_id, filter, ids, limit, names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_directory_services_test_patch_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, directory_service: Optional[DirectoryService] = None, **kwargs) → ApiResponse

PATCH directory-service/test # noqa: E501

Test the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_directory_services_test_patch_with_http_info(x_request_id, filter, ids, names, sort, directory_service, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • directory_service (DirectoryService) – An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.dns_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.dns_api.DNSApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_dns_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE dns # noqa: E501

Deletes a DNS configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_dns_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_dns_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET dns # noqa: E501

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_dns_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_dns_patch_with_http_info(dns: Dns, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH dns # noqa: E501

Modify a DNS configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_dns_patch_with_http_info(dns, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • dns (Dns) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsResponse, status_code(int), headers(HTTPHeaderDict))

api217_dns_post_with_http_info(names: ConstrainedListValue[StrictStr], dns: DnsPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST dns # noqa: E501

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_dns_post_with_http_info(names, dns, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • dns (DnsPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.drives_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.drives_api.DrivesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_drives_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET drives # noqa: E501

List array drive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_drives_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DriveGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.file_system_exports_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.file_system_exports_api.FileSystemExportsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_file_system_exports_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-system-exports # noqa: E501

Deletes a file system export. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_exports_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_system_exports_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-system-exports # noqa: E501

List one or more file system exports. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_exports_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_exports_patch_with_http_info(file_system_export: FileSystemExport, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH file-system-exports # noqa: E501

Modify a file system export’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_exports_patch_with_http_info(file_system_export, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • file_system_export (FileSystemExport) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemExportResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_exports_post_with_http_info(file_system_export: FileSystemExportPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST file-system-exports # noqa: E501

Create a file system export. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_exports_post_with_http_info(file_system_export, x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • file_system_export (FileSystemExportPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemExportResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.file_system_snapshots_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.file_system_snapshots_api.FileSystemSnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_file_system_snapshots_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-system-snapshots # noqa: E501

Delete a file system snapshot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_system_snapshots_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names_or_owner_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, owner_ids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET file-system-snapshots # noqa: E501

List file system snapshots. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, destroyed, filter, ids, limit, names_or_owner_names, offset, owner_ids, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names_or_owner_names (List[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

  • offset (int) – The offset of the first resource to return from a collection.

  • owner_ids (List[str]) – A comma-separated list of owning file system IDs. If after filtering, there is not at least one resource that matches each of the elements of owner IDs, then an error is returned. This cannot be provided together with the ids, names_or_owner_names, or names_or_sources query parameters.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_snapshots_patch_with_http_info(file_system_snapshot: FileSystemSnapshot, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, latest_replica: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH file-system-snapshots # noqa: E501

Modify file system snapshot attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_patch_with_http_info(file_system_snapshot, x_request_id, context_names, ids, latest_replica, names, async_req=True)
>>> result = thread.get()
Parameters

  • file_system_snapshot (FileSystemSnapshot) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • latest_replica (bool) – Used when destroying a snapshot. If not present or false, and the snapshot is the latest replicated snapshot, then destroy will fail. If true or the snapshot is not the latest replicated snapshot, then destroy will be successful.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_snapshots_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-system-snapshots/policies # noqa: E501

Remove snapshot scheduling policies from a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_policies_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_system_snapshots_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-system-snapshots/policies # noqa: E501

List file system snapshots mapped to snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyFileSystemSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_snapshots_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, send: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, targets: Optional[ConstrainedListValue[StrictStr]] = None, file_system_snapshot: Optional[FileSystemSnapshotPost] = None, **kwargs) → ApiResponse

POST file-system-snapshots # noqa: E501

Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_post_with_http_info(x_request_id, context_names, send, source_ids, source_names, targets, file_system_snapshot, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • send (bool) – Whether to replicate created snapshots immediately to other arrays. If it’s false, created snapshots may still be replicated to other arrays according to policy.

  • source_ids (List[str]) – A comma-separated list of source file system IDs. If after filtering, there is not at least one resource that matches each of the elements of source_ids, then an error is returned. This cannot be provided together with the names_or_sources or sources query parameters.

  • source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each of the elements of source_names, an error is returned.

  • targets (List[str]) – The target arrays to replicate created snapshots to. Only valid when send is true.

  • file_system_snapshot (FileSystemSnapshotPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_system_snapshots_transfer_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-system-snapshots/transfer # noqa: E501

Delete file system snapshot transfers from the source array to the target array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_transfer_delete_with_http_info(x_request_id, context_names, ids, names, remote_ids, remote_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_system_snapshots_transfer_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names_or_owner_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET file-system-snapshots/transfer # noqa: E501

List file system snapshot transfers from the source array to the target array. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_system_snapshots_transfer_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names_or_owner_names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names_or_owner_names (List[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemSnapshotGetTransferResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.file_systems_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.file_systems_api.FileSystemsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_file_systems_audit_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-systems/audit-policies # noqa: E501

Remove the audit policy mapped to a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_audit_policies_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_audit_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-systems/audit-policies # noqa: E501

List file systems mapped to a audit policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_audit_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesMembersGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_audit_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST file-systems/audit-policies # noqa: E501

Map a audit policy to a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_audit_policies_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesMembersResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-systems # noqa: E501

Deletes a file system. Deleting a file system is equivalent to eradication. A file system’s destroyed parameter must be set to true before a file system can be deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET file-systems # noqa: E501

List one or more file systems on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_groups_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET file-systems/groups/performance # noqa: E501

List a group’s I/O performance metrics on a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_groups_performance_get_with_http_info(x_request_id, file_system_ids, file_system_names, filter, gids, group_names, limit, names, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • gids (List[str]) – A comma-separated list of group IDs. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. This cannot be provided together with gids query parameter.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemGroupsPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_locks_clients_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

Get a list of clients that hold active file locks # noqa: E501

Lists all clients that hold active file locks. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_locks_clients_get_with_http_info(x_request_id, continuation_token, filter, limit, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemClientsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_locks_delete_with_http_info(x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, inodes: Optional[ConstrainedListValue[Union[StrictFloat, StrictInt]]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, recursive: Optional[StrictBool] = None, **kwargs) → ApiResponse

Invalidate file locks # noqa: E501

Invalidates file locks. It can be used to either delete an individual lock by name or multiple locks filtered by parameters. E.g. to delete locks held by a client on specific file, parameters client_names, file_system_ids or file_system_names and path must be specified. When names is specified, no other query parameter can be specified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_locks_delete_with_http_info(x_request_id, client_names, file_system_ids, file_system_names, inodes, names, paths, recursive, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • client_names (List[str]) – A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • inodes (List[float]) – A comma-separated list of inodes used for filtering file locks query by inodes. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the paths query parameter.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (List[str]) – A comma-separated list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • recursive (bool) – Flag used to indicate that the action should be done recursively. If set to true and used e.g. with path pointing to a directory, the operation will delete all locks in given directory and subdirectories recursively. For more fine grained control over deleted locks, use delete by name. If not specified, defaults to false.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_locks_get_with_http_info(x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, inodes: Optional[ConstrainedListValue[Union[StrictFloat, StrictInt]]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Get a list of active file locks # noqa: E501

Lists all active file locks that satisfy the conditions specified by the parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_locks_get_with_http_info(x_request_id, client_names, continuation_token, file_system_ids, file_system_names, filter, inodes, limit, names, paths, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • client_names (List[str]) – A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • inodes (List[float]) – A comma-separated list of inodes used for filtering file locks query by inodes. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the paths query parameter.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (List[str]) – A comma-separated list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileLockGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_locks_nlm_reclamations_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Initiate NLM reclamation. # noqa: E501

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_locks_nlm_reclamations_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileLockNlmReclamationResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_open_files_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-systems/open-files # noqa: E501

Close open file from given identifiers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_open_files_delete_with_http_info(x_request_id, ids, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_open_files_get_with_http_info(protocols: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, session_names: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET file-systems/open-files # noqa: E501

List open files. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_open_files_get_with_http_info(protocols, x_request_id, client_names, continuation_token, file_system_ids, file_system_names, ids, limit, paths, session_names, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • client_names (List[str]) – A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • paths (List[str]) – A comma-separated list of paths used for filtering open files query.

  • session_names (List[str]) – A comma-separated list of session names used for filtering open files query. Files opened in any of the specified sessions will be returned.

  • user_names (List[str]) – A comma-separated list of user names used for filtering open files query. Files opened by any of the specified users will be returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemOpenFilesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_patch_with_http_info(file_system: FileSystemPatch, x_request_id: Optional[StrictStr] = None, cancel_in_progress_storage_class_transition: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, delete_link_on_eradication: Optional[StrictBool] = None, discard_detailed_permissions: Optional[StrictBool] = None, discard_non_snapshotted_data: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH file-systems # noqa: E501

Modify a file system’s attributes including its export protocols and limits. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_patch_with_http_info(file_system, x_request_id, cancel_in_progress_storage_class_transition, context_names, delete_link_on_eradication, discard_detailed_permissions, discard_non_snapshotted_data, ids, ignore_usage, names, async_req=True)
>>> result = thread.get()
Parameters

  • file_system (FileSystemPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • cancel_in_progress_storage_class_transition (bool) – If set to true, the storage class policy of this file system will be set to the requested storage class policy, even if a transition to a different storage class is in-progress. Setting this parameter to true is acknowledgement that any in-progress transition on this file system will be cancelled. If not specified, the default value is false.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • delete_link_on_eradication (bool) – If set to true, the file system can be destroyed, even if it has a replica link. If set to false, the file system cannot be destroyed if it has a replica link. Defaults to false.

  • discard_detailed_permissions (bool) – This parameter must be set to true in order to change a file system’s access_control_style from a style that supports more detailed access control lists to a style that only supports less detailed mode bits as a form of permission control. This parameter may not be set to true any other time. Setting this parameter to true is acknowledgement that any more detailed access control lists currently set within the file system will be lost, and NFS permission controls will only be enforced at the granularity level of NFS mode bits.

  • discard_non_snapshotted_data (bool) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET file-systems/performance # noqa: E501

Displays the performance metrics for a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_performance_get_with_http_info(x_request_id, continuation_token, end_time, filter, ids, limit, names, offset, protocol, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • protocol (str) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_policies_all_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-systems/policies-all # noqa: E501

List file system policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_policies_all_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE file-systems/policies # noqa: E501

Remove a snapshot scheduling policy from a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_policies_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-systems/policies # noqa: E501

List file system snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST file-systems/policies # noqa: E501

Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy at a time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_policies_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_post_with_http_info(names: ConstrainedListValue[StrictStr], file_system: FileSystemPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, default_exports: Optional[ConstrainedListValue[StrictStr]] = None, discard_non_snapshotted_data: Optional[StrictBool] = None, overwrite: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST file-systems # noqa: E501

Create a file system on the current array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_post_with_http_info(names, file_system, x_request_id, context_names, default_exports, discard_non_snapshotted_data, overwrite, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • file_system (FileSystemPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • default_exports (List[str]) – A comma-separated list of export types to be created using default access. Creating a file system with an explicit nfs.rules or nfs.export_policy value will always create a NFS export to the default server regardless of this flag. If these are not set and default_exports includes nfs, then nfs.rules will be set to “*(rw,no_root_squash)” and a NFS export to the default server will be created. Otherwise nfs.rules will be set to “” and no NFS export will be created. Creating a file system with an explicit smb.client_policy or smb.share_policy value will always create a SMB export to the default server regardless of this flag. If these are not set and default_exports includes smb, then a SMB export to the default server will be created with default policies. Otherwise no SMB export will be created. Use empty string (“”) to not create these default exports. Default is nfs,smb.

  • discard_non_snapshotted_data (bool) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

  • overwrite (bool) – When used for snapshot restore, overwrites (true) an existing file system.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_sessions_delete_with_http_info(x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, disruptive: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, protocols: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete sessions # noqa: E501

Delete sessions. It can be used to either delete an individual session by name or multiple sessions filtered by parameters. E.g. to delete SMBv3 sessions held by specific client, protocols and client_names must be specified. To prevent accidental deletes, setting flag disruptive to true is required when only a single query parameter is part of the query. E.g. to delete all SMBv3 sessions, query parameters protocols and disruptive must be set. When names is specified, no other query parameter can be specified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_sessions_delete_with_http_info(x_request_id, client_names, disruptive, names, protocols, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • client_names (List[str]) – A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • disruptive (bool) – If set to true, a wide scope of sessions may be deleted in a single action using a single query parameter from user_names, client_names, or protocols. Otherwise, multiple query parameters must be specified to narrow the impact of deletion and avoid potential for accidental disruption of clients.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb.

  • user_names (List[str]) – A comma-separated list of user names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_file_systems_sessions_get_with_http_info(x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, protocols: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Get a list of active sessions # noqa: E501

Lists all active sessions that satisfy the conditions specified by the parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_sessions_get_with_http_info(x_request_id, client_names, continuation_token, limit, names, protocols, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • client_names (List[str]) – A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb.

  • user_names (List[str]) – A comma-separated list of user names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSessionGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_users_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET file-systems/users/performance # noqa: E501

List a user’s I/O performance metrics on a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_users_performance_get_with_http_info(x_request_id, file_system_ids, file_system_names, filter, limit, names, sort, total_only, uids, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • uids (List[int]) – A comma-separated list of user IDs. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemUsersPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_file_systems_worm_data_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET file-systems/worm-data-policies # noqa: E501

List file systems mapped to a WORM data policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_file_systems_worm_data_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(WormDataPoliciesMembersGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.fleets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.fleets_api.FleetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_fleets_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE Fleets # noqa: E501

Permanently delete a fleet. A fleet can only be deleted if the current array is the only array in the fleet. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

  • names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_fleets_fleet_key_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET fleet-key # noqa: E501

Displays the time remaining on the fleet key. Note: fleet key itself is not displayed, since that is only available at the time of fleet key creation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_fleet_key_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_fleet_key_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST fleet-key # noqa: E501

Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note: Creation of a subsequent key invalidates all keys created earlier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_fleet_key_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetKeyResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET fleets # noqa: E501

Displays information about the fleets known to the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_members_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, unreachable: Optional[StrictBool] = None, **kwargs) → ApiResponse

Remove fleet members # noqa: E501

Remove the specified array(s) from the fleet. Note: that this will only succeed if the array(s) to be removed are not making use of any fleet resources. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_members_delete_with_http_info(x_request_id, member_ids, member_names, unreachable, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • unreachable (bool) – If set to true, allows a one-sided disconnect when the connection status is connecting instead of connected or partially connected. If set to false, it works just like normal coordinated disconnect. If not specified, defaults to false.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_fleets_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET fleet members # noqa: E501

Displays the members in the current fleet. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_members_get_with_http_info(x_request_id, continuation_token, filter, fleet_ids, fleet_names, limit, member_ids, member_names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

  • fleet_names (List[str]) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_members_post_with_http_info(x_request_id: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, members: Optional[FleetMemberPost] = None, **kwargs) → ApiResponse

POST fleets # noqa: E501

Adds arrays to an existing fleet. This API needs to be run from the array that’s joining the fleet. To add the current array to the fleet, specify its own array id or name as well as the fleet key generated on any array already in the fleet. resource_type is remote-arrays. The array’s ID and name can be retrieved with a call to GET /arrays on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_members_post_with_http_info(x_request_id, fleet_ids, fleet_names, members, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

  • fleet_names (List[str]) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

  • members (FleetMemberPost) – Info about the members being added to fleet.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_patch_with_http_info(fleet: FleetPatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH fleets # noqa: E501

Rename a fleet by passing the old name in name query parameter, and the new name in the name parameter in the request body. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_patch_with_http_info(fleet, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • fleet (FleetPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

  • names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetResponse, status_code(int), headers(HTTPHeaderDict))

api217_fleets_post_with_http_info(x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST fleets # noqa: E501

Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with POST /fleets/members # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_fleets_post_with_http_info(x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.hardware_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.hardware_api.HardwareApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_hardware_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET hardware # noqa: E501

List hardware slots and bays and the status of installed components. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_hardware_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_hardware_patch_with_http_info(hardware: Hardware, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH hardware # noqa: E501

Controls the visual identification light of the specified hardware component. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_hardware_patch_with_http_info(hardware, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • hardware (Hardware) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.hardware_connectors_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.hardware_connectors_api.HardwareConnectorsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_hardware_connectors_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET hardware-connectors # noqa: E501

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. List array connection information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_hardware_connectors_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareConnectorGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_hardware_connectors_patch_with_http_info(hardware_connector: HardwareConnector, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH hardware-connectors # noqa: E501

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. Modify array connection information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_hardware_connectors_patch_with_http_info(hardware_connector, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • hardware_connector (HardwareConnector) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareConnectorResponse, status_code(int), headers(HTTPHeaderDict))

api217_hardware_connectors_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET hardware-connectors/performance # noqa: E501

The endpoint is deprecated. Use the /network-interfaces/connectors/performance endpoint instead. Displays network statistics, historical bandwidth, and error reporting for all specified hardware connectors. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_hardware_connectors_performance_get_with_http_info(x_request_id, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareConnectorPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.keytabs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.keytabs_api.KeytabsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_keytabs_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE keytabs # noqa: E501

Delete a Kerberos keytab file. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_keytabs_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_keytabs_download_get_with_http_info(x_request_id: Optional[StrictStr] = None, keytab_ids: Optional[ConstrainedListValue[StrictStr]] = None, keytab_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET keytabs/download # noqa: E501

Download a Kerberos keytab file. The file can be downloaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_keytabs_download_get_with_http_info(x_request_id, keytab_ids, keytab_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • keytab_ids (List[str]) – A comma-separated list of keytab IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the keytab_names query parameter.

  • keytab_names (List[str]) – A comma-separated list of keytab names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with keytab_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(bytearray, status_code(int), headers(HTTPHeaderDict))

api217_keytabs_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET keytabs # noqa: E501

List a Kerberos keytab file and its configuration information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_keytabs_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KeytabGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_keytabs_post_with_http_info(keytab: KeytabPost, x_request_id: Optional[StrictStr] = None, name_prefixes: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST keytabs # noqa: E501

Import a Kerberos keytab file from a Key Distribution Center. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_keytabs_post_with_http_info(keytab, x_request_id, name_prefixes, async_req=True)
>>> result = thread.get()
Parameters

  • keytab (KeytabPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KeytabResponse, status_code(int), headers(HTTPHeaderDict))

api217_keytabs_upload_post_with_http_info(keytab_file: StrictStr, x_request_id: Optional[StrictStr] = None, name_prefixes: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST keytabs/upload # noqa: E501

Upload a Kerberos keytab file to the array. The file can be uploaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. The procedure to upload a file may vary depending on the type of REST client. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_keytabs_upload_post_with_http_info(keytab_file, x_request_id, name_prefixes, async_req=True)
>>> result = thread.get()
Parameters

  • keytab_file (str) – The keytab file to upload. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(bytearray, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.kmip_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.kmip_api.KMIPApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_kmip_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a KMIP server configuration # noqa: E501

Deletes a KMIP server configuration. A server can only be deleted when not in use by the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_kmip_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_kmip_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List KMIP server configurations # noqa: E501

Displays a list of KMIP server configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_kmip_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_kmip_patch_with_http_info(kmip_server: KmipServer, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a KMIP server configuration # noqa: E501

Modifies KMIP server properties - URI, certificate, certificate group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_kmip_patch_with_http_info(kmip_server, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • kmip_server (KmipServer) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_kmip_post_with_http_info(kmip_server: KmipServer, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a KMIP server configuration # noqa: E501

Creates a KMIP server configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_kmip_post_with_http_info(kmip_server, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • kmip_server (KmipServer) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_kmip_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Displays KMIP server test results # noqa: E501

Displays a detailed result of of KMIP server test. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_kmip_test_get_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.legal_holds_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.legal_holds_api.LegalHoldsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Delete a legal hold # noqa: E501

Delete a legal hold instance. Deletion is not allowed if the legal hold is applied to one or more paths. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

List legal holds # noqa: E501

List legal holds. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsGetResponse, status_code(int), headers(HTTPHeaderDict))

List held entities # noqa: E501

List entities to which a legal hold has been applied. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_held_entities_get_with_http_info(x_request_id, continuation_token, file_system_ids, file_system_names, ids, limit, names, paths, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (List[str]) – A comma-separated list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsHeldEntitiesGetResponse, status_code(int), headers(HTTPHeaderDict))

Release this legal hold from the given entity # noqa: E501

Release this legal hold from the given entity. The names, file_system_names, paths and released query parameters are required. The recursive flag is required when releasing a hold from a directory. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_held_entities_patch_with_http_info(released, x_request_id, file_system_ids, file_system_names, ids, names, paths, recursive, async_req=True)
>>> result = thread.get()
Parameters

  • released (bool) – This is a flag to set when releasing an attached legal hold from a path. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (List[str]) – A comma-separated list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • recursive (bool) – This is a flag to set when recursively applying/releasing legal holds on entities. By default, it is set to be false. The recursive flag is required when applying/releasing a hold to/from a directory.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsHeldEntitiesResponse, status_code(int), headers(HTTPHeaderDict))

api217_legal_holds_held_entities_post_with_http_info(x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, recursive: Optional[StrictBool] = None, **kwargs) → ApiResponse

Apply this legal hold to a new entity # noqa: E501

Apply this legal hold to a new entity. The names, file_system_names and paths query parameters are required. The recursive flag is required when applying a hold to a directory. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_held_entities_post_with_http_info(x_request_id, file_system_ids, file_system_names, ids, names, paths, recursive, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (List[str]) – A comma-separated list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • recursive (bool) – This is a flag to set when recursively applying/releasing legal holds on entities. By default, it is set to be false. The recursive flag is required when applying/releasing a hold to/from a directory.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsHeldEntitiesResponse, status_code(int), headers(HTTPHeaderDict))

Update a legal hold # noqa: E501

Update a legal hold instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_patch_with_http_info(x_request_id, ids, names, hold, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • hold (LegalHold) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsResponse, status_code(int), headers(HTTPHeaderDict))

api217_legal_holds_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, hold: Optional[LegalHold] = None, **kwargs) → ApiResponse

Create a legal hold # noqa: E501

Create a legal hold instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_legal_holds_post_with_http_info(names, x_request_id, hold, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • hold (LegalHold) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LegalHoldsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.lifecycle_rules_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.lifecycle_rules_api.LifecycleRulesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_lifecycle_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE lifecycle-rules # noqa: E501

Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, delete all the rules for the bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_lifecycle_rules_delete_with_http_info(x_request_id, bucket_ids, bucket_names, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_lifecycle_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET lifecycle-rules # noqa: E501

Returns a list of lifecycle rules. If names is specified, list the individual rules. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, list all the rules for the bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_lifecycle_rules_get_with_http_info(x_request_id, allow_errors, bucket_ids, bucket_names, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LifecycleRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_lifecycle_rules_patch_with_http_info(lifecycle: LifecycleRulePatch, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, confirm_date: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH lifecycle-rules # noqa: E501

Modify an existing lifecycle rule by name or id. If ids is specified, bucket_names or bucket_ids is also required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_lifecycle_rules_patch_with_http_info(lifecycle, x_request_id, bucket_ids, bucket_names, confirm_date, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • lifecycle (LifecycleRulePatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

  • confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LifecycleRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_lifecycle_rules_post_with_http_info(rule: LifecycleRulePost, x_request_id: Optional[StrictStr] = None, confirm_date: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST lifecycle-rules # noqa: E501

Creates a lifecycle rule. bucket and keep_previous_version_for are required. If rule_id is not specified, it will be automatically generated in the format “fbRuleIdX”. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_lifecycle_rules_post_with_http_info(rule, x_request_id, confirm_date, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (LifecycleRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LifecycleRuleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.logs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.logs_api.LogsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_logs_async_download_get_with_http_info(x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET logs-async/download # noqa: E501

Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_logs_async_download_get_with_http_info(x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(bytearray, status_code(int), headers(HTTPHeaderDict))

api217_logs_async_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET logs-async # noqa: E501

List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_logs_async_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogsAsyncGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_logs_async_patch_with_http_info(logs_async: LogsAsync, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH logs-async # noqa: E501

Start the preparation for a history of log events from the array to provide to Pure Technical Services for analysis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_logs_async_patch_with_http_info(logs_async, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • logs_async (LogsAsync) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogsAsyncResponse, status_code(int), headers(HTTPHeaderDict))

api217_logs_get_with_http_info(x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

GET logs # noqa: E501

Download a history of log events from the array to provide to Pure Technical Services for analysis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_logs_get_with_http_info(x_request_id, end_time, start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(bytearray, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.maintenance_windows_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.maintenance_windows_api.MaintenanceWindowsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_maintenance_windows_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete maintenance window # noqa: E501

Deletes an active maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_maintenance_windows_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_maintenance_windows_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List maintenance window details # noqa: E501

Displays maintenance window details, including start time, end time, and maintenance type. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_maintenance_windows_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MaintenanceWindowsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_maintenance_windows_post_with_http_info(names: ConstrainedListValue[StrictStr], maintenance_window: MaintenanceWindowPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a maintenance window # noqa: E501

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_maintenance_windows_post_with_http_info(names, maintenance_window, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • maintenance_window (MaintenanceWindowPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MaintenanceWindowsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.network_interfaces_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.network_interfaces_api.NetworkInterfacesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_network_interfaces_connectors_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-interfaces/connectors # noqa: E501

List network connector information # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_connectors_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacesConnectorsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_connectors_patch_with_http_info(network_connector: HardwareConnector, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH network-interfaces/connectors # noqa: E501

Modify network connector information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_connectors_patch_with_http_info(network_connector, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • network_connector (HardwareConnector) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacesConnectorsResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_connectors_performance_get_with_http_info(x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET network connectors performance statistics # noqa: E501

Displays network statistics, historical bandwidth, and error reporting for all specified network connectors. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_connectors_performance_get_with_http_info(x_request_id, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacesConnectorsPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_connectors_settings_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET global network settings for network connectors # noqa: E501

Display the global network settings for network connectors. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_connectors_settings_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacesConnectorsSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE network-interfaces # noqa: E501

Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP will lose their connection to the file system or bucket. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_network_interfaces_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-interfaces # noqa: E501

List network interfaces and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_patch_with_http_info(network_interface: NetworkInterfacePatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH network-interfaces # noqa: E501

Modify the attributes of a VIP. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_patch_with_http_info(network_interface, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • network_interface (NetworkInterfacePatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_ping_get_with_http_info(destination: StrictStr, x_request_id: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, count: Optional[StrictInt] = None, packet_size: Optional[StrictInt] = None, print_latency: Optional[StrictBool] = None, resolve_hostname: Optional[StrictBool] = None, source: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET network-interfaces/ping # noqa: E501

Display network interface ping result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_ping_get_with_http_info(destination, x_request_id, component_name, count, packet_size, print_latency, resolve_hostname, source, async_req=True)
>>> result = thread.get()
Parameters

  • destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

  • count (int) – Used by ping to specify the number of packets to send. If not specified, defaults to 1.

  • packet_size (int) – Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56.

  • print_latency (bool) – Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false.

  • resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

  • source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacePingGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_post_with_http_info(names: ConstrainedListValue[StrictStr], network_interface: NetworkInterface, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST network-interfaces # noqa: E501

Create a VIP to export data or perform replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_post_with_http_info(names, network_interface, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • network_interface (NetworkInterface) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_trace_get_with_http_info(destination: StrictStr, x_request_id: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, discover_mtu: Optional[StrictBool] = None, fragment_packet: Optional[StrictBool] = None, method: Optional[StrictStr] = None, port: Optional[StrictStr] = None, resolve_hostname: Optional[StrictBool] = None, source: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET network-interfaces/trace # noqa: E501

Display network interface trace result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_trace_get_with_http_info(destination, x_request_id, component_name, discover_mtu, fragment_packet, method, port, resolve_hostname, source, async_req=True)
>>> result = thread.get()
Parameters

  • destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

  • discover_mtu (bool) – Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false.

  • fragment_packet (bool) – Used by trace to specify whether or not to fragment packets. If not specified, defaults to true.

  • method (str) – Used by trace to specify which method to use for trace operations. Valid values are icmp, tcp, and udp. If not specified, defaults to ‘udp’.

  • port (str) – Used by trace to specify a destination port.

  • resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

  • source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceTraceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_access_keys_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_access_keys_api.ObjectStoreAccessKeysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_access_keys_delete_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-access-keys # noqa: E501

Delete an object store access key. Once an access key has been deleted, it cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_keys_delete_with_http_info(names, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_access_keys_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-keys # noqa: E501

List object store access keys. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_keys_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_keys_patch_with_http_info(names: ConstrainedListValue[StrictStr], object_store_access_key: ObjectStoreAccessKey, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-access-keys # noqa: E501

Enable or disable object store access keys. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_keys_patch_with_http_info(names, object_store_access_key, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • object_store_access_key (ObjectStoreAccessKey) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessKeyResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_keys_post_with_http_info(object_store_access_key: ObjectStoreAccessKeyPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-access-keys # noqa: E501

Create or import object store access keys. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_keys_post_with_http_info(object_store_access_key, x_request_id, context_names, names, async_req=True)
>>> result = thread.get()
Parameters

  • object_store_access_key (ObjectStoreAccessKeyPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names to import. To import a set of credentials, this field must be specified with the secret_access_key body parameter. If both of these are not specified, the system will generate a new set of credentials.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessKeyResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_accounts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_accounts_api.ObjectStoreAccountsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_accounts_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-accounts # noqa: E501

Delete an object store account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_accounts_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_accounts_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET object-store-accounts # noqa: E501

List object store accounts and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_accounts_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccountGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_accounts_patch_with_http_info(object_store_account: ObjectStoreAccountPatch, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-accounts # noqa: E501

Modify object store account attributes such as quota limit and bucket defaults. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_accounts_patch_with_http_info(object_store_account, x_request_id, context_names, ids, ignore_usage, names, async_req=True)
>>> result = thread.get()
Parameters

  • object_store_account (ObjectStoreAccountPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccountResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_accounts_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, object_store_account: Optional[ObjectStoreAccountPost] = None, **kwargs) → ApiResponse

POST object-store-accounts # noqa: E501

Create an object store account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_accounts_post_with_http_info(names, x_request_id, context_names, object_store_account, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • object_store_account (ObjectStoreAccountPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccountResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_remote_credentials_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_remote_credentials_api.ObjectStoreRemoteCredentialsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_remote_credentials_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-remote-credentials # noqa: E501

Delete object store remote credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_remote_credentials_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_remote_credentials_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-remote-credentials # noqa: E501

List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_remote_credentials_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRemoteCredentialGetResp, status_code(int), headers(HTTPHeaderDict))

api217_object_store_remote_credentials_patch_with_http_info(remote_credentials: ObjectStoreRemoteCredentials, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-remote-credentials # noqa: E501

Rename and/or change the access key/secret key pair for object store remote credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_remote_credentials_patch_with_http_info(remote_credentials, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • remote_credentials (ObjectStoreRemoteCredentials) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRemoteCredentialsResp, status_code(int), headers(HTTPHeaderDict))

api217_object_store_remote_credentials_post_with_http_info(names: ConstrainedListValue[StrictStr], remote_credentials: ObjectStoreRemoteCredentialsPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-remote-credentials # noqa: E501

Create object store remote credentials to set up bucket replicat links to a remote array or target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_remote_credentials_post_with_http_info(names, remote_credentials, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • remote_credentials (ObjectStoreRemoteCredentialsPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRemoteCredentialsResp, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_roles_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_roles_api.ObjectStoreRolesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_roles_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-roles # noqa: E501

Delete existing object store roles. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_roles_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-roles # noqa: E501

List object store roles and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRoleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_access_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-roles/object-store-access-policies # noqa: E501

Revoke an object store role’s access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_access_policies_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_roles_object_store_access_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-roles/object-store-access-policies # noqa: E501

List object store roles and their access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_access_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_access_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-roles/object-store-access-policies # noqa: E501

Grant access policies to an object store role. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_access_policies_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_download_get_with_http_info(x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET object-store-roles/object-store-trust-policies/download # noqa: E501

Download object store roles and their trust policies in native AWS format. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_download_get_with_http_info(x_request_id, names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(str, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-roles/object-store-trust-policies # noqa: E501

List object store roles and their trust policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, names, offset, role_ids, role_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreTrustPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-roles/object-store-trust-policies/rules # noqa: E501

Delete one or more trust policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_rules_delete_with_http_info(x_request_id, context_names, indices, names, policy_names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • indices (List[int]) – A comma-separated list of resource indices. If there is not at least one resource that matches each of the elements of indices, then an error is returned.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_roles_object_store_trust_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-roles/object-store-trust-policies/rules # noqa: E501

List trust policy rules and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_rules_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, indices, limit, names, offset, policy_names, role_ids, role_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • indices (List[int]) – A comma-separated list of resource indices. If there is not at least one resource that matches each of the elements of indices, then an error is returned.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreTrustPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_rules_patch_with_http_info(rule: TrustPolicyRulePost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-roles/object-store-trust-policies/rules # noqa: E501

Modify a trust policy rule’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_rules_patch_with_http_info(rule, x_request_id, context_names, indices, names, policy_names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (TrustPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • indices (List[int]) – A comma-separated list of resource indices. If there is not at least one resource that matches each of the elements of indices, then an error is returned.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreTrustPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_rules_post_with_http_info(rule: TrustPolicyRulePost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-roles/object-store-trust-policies/rules # noqa: E501

Create a new trust policy rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_rules_post_with_http_info(rule, x_request_id, context_names, names, policy_names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (TrustPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreTrustPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_object_store_trust_policies_upload_patch_with_http_info(policy_document: StrictStr, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-roles/object-store-trust-policies/upload # noqa: E501

Upload object store roles and their trust policies in native AWS format. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_object_store_trust_policies_upload_patch_with_http_info(policy_document, x_request_id, context_names, names, role_ids, role_names, async_req=True)
>>> result = thread.get()
Parameters

  • policy_document (str) – The trust policy document to upload. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • role_ids (List[str]) – A comma-separated list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (List[str]) – A comma-separated list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreTrustPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_patch_with_http_info(object_store_role: ObjectStoreRole, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-roles # noqa: E501

Modify existing object store roles. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_patch_with_http_info(object_store_role, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • object_store_role (ObjectStoreRole) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRoleResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_roles_post_with_http_info(names: ConstrainedListValue[StrictStr], object_store_role: ObjectStoreRolePost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-roles # noqa: E501

Create new object store roles. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_roles_post_with_http_info(names, object_store_role, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • object_store_role (ObjectStoreRolePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreRoleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_users_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_users_api.ObjectStoreUsersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_users_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-users # noqa: E501

Delete an object store user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_users_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-users # noqa: E501

List object store users and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreUserGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_users_object_store_access_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-users/object-store-access-policies # noqa: E501

Revoke an object store user’s access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_object_store_access_policies_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_users_object_store_access_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-users/object-store-access-policies # noqa: E501

List object store users and their access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_object_store_access_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_users_object_store_access_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-users/object-store-access-policies # noqa: E501

Grant access policies to an object store user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_object_store_access_policies_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_users_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, full_access: Optional[StrictBool] = None, **kwargs) → ApiResponse

POST object-store-users # noqa: E501

Create object store users to administer object storage for an object store account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_users_post_with_http_info(names, x_request_id, context_names, full_access, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • full_access (bool) – If set to true, creates an object store user with full permissions. If set to false, creates an object store user with no permission. If not specified, defaults to false.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreUserResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.object_store_virtual_hosts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.object_store_virtual_hosts_api.ObjectStoreVirtualHostsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_virtual_hosts_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-virtual-hosts # noqa: E501

Delete an object store virtual host. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_virtual_hosts_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_virtual_hosts_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-virtual-hosts # noqa: E501

List object store virtual hosts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_virtual_hosts_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreVirtualHostGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_virtual_hosts_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-virtual-hosts # noqa: E501

Create an object store virtual host. An example of a hostname is buckethost.example.com. A hostname cannot exceed 255 characters in length, it cannot be an IP address, only 10 hostnames are supported, supersets or subsets of existing hostnames with the same root are not allowed. The default hostname is s3.amazonaws.com and it cannot be deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_virtual_hosts_post_with_http_info(names, x_request_id, context_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreVirtualHostResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.oidcsso_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.oidcsso_api.OIDCSSOApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_sso_oidc_idps_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete OIDC SSO configurations # noqa: E501

Delete OIDC SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_oidc_idps_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_sso_oidc_idps_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List OIDC SSO configurations # noqa: E501

Displays the OIDC SSO configuration settings in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_oidc_idps_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OidcSsoGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_oidc_idps_patch_with_http_info(idp: OidcSsoPatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify OIDC SSO configuration # noqa: E501

Modify one or more attributes of OIDC SSO configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_oidc_idps_patch_with_http_info(idp, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • idp (OidcSsoPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OidcSsoResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_oidc_idps_post_with_http_info(idp: OidcSsoPost, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create OIDC SSO configuration # noqa: E501

Create OIDC SSO configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_oidc_idps_post_with_http_info(idp, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • idp (OidcSsoPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OidcSsoResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_all_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_all_api.PoliciesAllApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_policies_all_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies-all # noqa: E501

List all policies of all types. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_all_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyBaseGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_all_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies-all/members # noqa: E501

List policies (of all types) mapped to other entities (file systems, snapshots, file system replica links, and object store users). Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_all_members_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, local_file_system_ids, local_file_system_names, member_ids, member_names, member_types, offset, policy_ids, policy_names, remote_file_system_ids, remote_file_system_names, remote_ids, remote_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • member_types (List[str]) – A comma-separated list of member types. Valid values are file-systems, file-system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

  • remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberWithRemoteGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_audit_for_file_systems_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_audit_for_file_systems_api.PoliciesAuditForFileSystemsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_audit_file_systems_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE audit-file-systems-policies # noqa: E501

Delete one or more audit policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_audit_file_systems_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET audit-file-systems-policies # noqa: E501

Displays a list of audit policies for file systems. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_audit_file_systems_policies_members_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE audit-file-systems-policies/members # noqa: E501

Remove the audit policy mapped to a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_members_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_audit_file_systems_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET audit-file-systems-policies/members # noqa: E501

List file systems mapped to a audit policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_members_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesMembersGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_audit_file_systems_policies_members_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST audit-file-systems-policies/members # noqa: E501

Map a file system to a audit policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_members_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesMembersResponse, status_code(int), headers(HTTPHeaderDict))

api217_audit_file_systems_policies_patch_with_http_info(policy: AuditFileSystemsPoliciesPatch, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH audit-file-systems-policies # noqa: E501

Modify an existing audit policy’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_patch_with_http_info(policy, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (AuditFileSystemsPoliciesPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

api217_audit_file_systems_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[AuditFileSystemsPoliciesPost] = None, **kwargs) → ApiResponse

POST audit-file-systems-policies # noqa: E501

Create a new audit policy for file systems. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_audit_file_systems_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (AuditFileSystemsPoliciesPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditFileSystemsPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_network_access_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_network_access_api.PoliciesNetworkAccessApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_network_access_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-access-policies # noqa: E501

Displays a list of network access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkAccessPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_access_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-access-policies/members # noqa: E501

List network access policies mapped to different configurations on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_members_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_access_policies_patch_with_http_info(policy: NetworkAccessPolicy, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH network-access-policies # noqa: E501

Modify an existing network access policy’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_patch_with_http_info(policy, x_request_id, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • policy (NetworkAccessPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkAccessPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_access_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE network-access-policies/rules # noqa: E501

Delete one or more network access policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_rules_delete_with_http_info(x_request_id, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_network_access_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-access-policies/rules # noqa: E501

Displays a list of network access policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_rules_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkAccessPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_access_policies_rules_patch_with_http_info(rule: NetworkAccessPolicyRule, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH network-access-policies/rules # noqa: E501

Modify an existing network access policy rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_rules_patch_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (NetworkAccessPolicyRule) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkAccessPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_access_policies_rules_post_with_http_info(rule: NetworkAccessPolicyRulePost, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST network-access-policies/rules # noqa: E501

Create a new network access policy rule. Either policy_ids or policy_names parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_access_policies_rules_post_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, policy_ids, policy_names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (NetworkAccessPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkAccessPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_nfs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_nfs_api.PoliciesNFSApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_nfs_export_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE nfs-export-policies # noqa: E501

Delete one or more NFS export policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_delete_with_http_info(x_request_id, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_nfs_export_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET nfs-export-policies # noqa: E501

Displays a list of NFS export policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_nfs_export_policies_patch_with_http_info(policy: NfsExportPolicy, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH nfs-export-policies # noqa: E501

Modify an existing NFS export policy’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_patch_with_http_info(policy, x_request_id, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • policy (NfsExportPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_nfs_export_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[NfsExportPolicyPost] = None, **kwargs) → ApiResponse

POST nfs-export-policies # noqa: E501

Create a new NFS export policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (NfsExportPolicyPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_nfs_export_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE nfs-export-policies/rules # noqa: E501

Delete one or more NFS export policy rules. One of the following is required: ids or names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_rules_delete_with_http_info(x_request_id, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_nfs_export_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET nfs-export-policies/rules # noqa: E501

Displays a list of NFS export policy rules. The default sort is by policy name, then index. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_rules_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_nfs_export_policies_rules_patch_with_http_info(rule: NfsExportPolicyRule, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH nfs-export-policies/rules # noqa: E501

Modify an existing NFS export policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_rules_patch_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (NfsExportPolicyRule) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_nfs_export_policies_rules_post_with_http_info(rule: NfsExportPolicyRule, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST nfs-export-policies/rules # noqa: E501

Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id and before_rule_name are specified. Rules can only be inserted into the appropriate group. Either policy_ids or policy_names parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_nfs_export_policies_rules_post_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, context_names, policy_ids, policy_names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (NfsExportPolicyRule) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NfsExportPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_object_store_access_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_object_store_access_api.PoliciesObjectStoreAccessApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_object_store_access_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-access-policies # noqa: E501

Delete one or more access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_access_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, exclude_rules: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-policies # noqa: E501

List access policies and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, exclude_rules, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • exclude_rules (bool) – If true, the rules field in each policy will be null. If false, each returned policy will include its list of rules in the response. If not specified, defaults to false.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_object_store_roles_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-access-policies/object-store-roles # noqa: E501

Revoke an object store role’s access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_roles_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_access_policies_object_store_roles_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-policies/object-store-roles # noqa: E501

List object store roles and their access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_roles_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_object_store_roles_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-access-policies/object-store-roles # noqa: E501

Grant access policies to an object store role. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_roles_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_object_store_users_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-access-policies/object-store-users # noqa: E501

Revokes an object store user’s access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_users_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_access_policies_object_store_users_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-policies/object-store-users # noqa: E501

List object store users and their access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_users_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_object_store_users_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-access-policies/object-store-users # noqa: E501

Grant access policies to an object store user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_object_store_users_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_patch_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[ObjectStoreAccessPolicyPatch] = None, **kwargs) → ApiResponse

PATCH object-store-access-policies # noqa: E501

Modify the rules of an object store access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_patch_with_http_info(x_request_id, context_names, enforce_action_restrictions, ids, names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy (ObjectStoreAccessPolicyPatch) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, policy: Optional[ObjectStoreAccessPolicyPost] = None, **kwargs) → ApiResponse

POST object-store-access-policies # noqa: E501

Create a new access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_post_with_http_info(names, x_request_id, context_names, enforce_action_restrictions, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • policy (ObjectStoreAccessPolicyPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE object-store-access-policies-rules # noqa: E501

Delete one or more access policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_rules_delete_with_http_info(x_request_id, context_names, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_object_store_access_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-policies-rules # noqa: E501

List access policy rules and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_rules_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_rules_patch_with_http_info(rule: PolicyRuleObjectAccessPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH object-store-access-policies-rules # noqa: E501

Modify an access policy rule’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_rules_patch_with_http_info(rule, x_request_id, context_names, enforce_action_restrictions, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (PolicyRuleObjectAccessPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policies_rules_post_with_http_info(names: ConstrainedListValue[StrictStr], rule: PolicyRuleObjectAccessPost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST object-store-access-policies-rules # noqa: E501

Create a new access policy rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policies_rules_post_with_http_info(names, rule, x_request_id, context_names, enforce_action_restrictions, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • rule (PolicyRuleObjectAccessPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_object_store_access_policy_actions_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET object-store-access-policy-actions # noqa: E501

List valid actions for access policy rules. Each action is either a valid AWS S3 action (prefixed by s3:) or our special wildcard action (s3:*). Each action, when included in a rule, may restrict which other properties may be set for that rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_object_store_access_policy_actions_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ObjectStoreAccessPolicyActionGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_password_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_password_api.PoliciesPasswordApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_password_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List password policies # noqa: E501

Displays a list of password policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_password_policies_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PasswordPoliciesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_password_policies_patch_with_http_info(policy: PasswordPolicy, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify password policies # noqa: E501

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_password_policies_patch_with_http_info(policy, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (PasswordPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PasswordPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_qo_s_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_qo_s_api.PoliciesQoSApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_qos_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE qos-policies # noqa: E501

Delete a QoS policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_qos_policies_file_systems_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET qos-policies/file-systems # noqa: E501

List qos policies and their file system members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_file_systems_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_qos_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET qos-policies # noqa: E501

List QoS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(QosPoliciesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_qos_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET qos-policies/members # noqa: E501

List qos policies and their managed object members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_members_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_qos_policies_patch_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[QosPolicy] = None, **kwargs) → ApiResponse

PATCH qos-policies # noqa: E501

Modify a QoS policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_patch_with_http_info(x_request_id, ids, names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy (QosPolicy) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(QosPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

api217_qos_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], policy: QosPolicy, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST qos-policies # noqa: E501

Create a QoS policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_qos_policies_post_with_http_info(names, policy, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • policy (QosPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(QosPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_smb_client_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_smb_client_api.PoliciesSMBClientApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_smb_client_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE smb-client-policies # noqa: E501

Delete one or more SMB Client policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_smb_client_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET smb-client-policies # noqa: E501

Display SMB Client policies and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_client_policies_patch_with_http_info(policy: SmbClientPolicy, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH smb-client-policies # noqa: E501

Modify an existing SMB Client policy’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_patch_with_http_info(policy, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (SmbClientPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_client_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[SmbClientPolicyPost] = None, **kwargs) → ApiResponse

POST smb-client-policies # noqa: E501

Create a new SMB Client policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (SmbClientPolicyPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_client_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE smb-client-policies/rules # noqa: E501

Delete one or more SMB Client policy rules. One of the following is required: ids or names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_rules_delete_with_http_info(x_request_id, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_smb_client_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET smb-client-policies/rules # noqa: E501

Displays a list of SMB Client policy rules. The default sort is by policy name, then index. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_rules_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_client_policies_rules_patch_with_http_info(rule: SmbClientPolicyRule, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH smb-client-policies/rules # noqa: E501

Modify an existing SMB Client policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_rules_patch_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, context_names, ids, names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (SmbClientPolicyRule) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_client_policies_rules_post_with_http_info(rule: SmbClientPolicyRulePost, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST smb-client-policies/rules # noqa: E501

Add an SMB Client policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id nor before_rule_name are specified. Rules can only be inserted into the appropriate group. The policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_client_policies_rules_post_with_http_info(rule, x_request_id, before_rule_id, before_rule_name, context_names, policy_ids, policy_names, versions, async_req=True)
>>> result = thread.get()
Parameters

  • rule (SmbClientPolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbClientPolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_smb_share_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_smb_share_api.PoliciesSMBShareApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_smb_share_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE smb-share-policies # noqa: E501

Delete one or more SMB Share policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_smb_share_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET smb-share-policies # noqa: E501

Display SMB Share policies and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_share_policies_patch_with_http_info(policy: SmbSharePolicy, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH smb-share-policies # noqa: E501

Modify an existing SMB Share policy’s attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_patch_with_http_info(policy, x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (SmbSharePolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_share_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[SmbSharePolicyPost] = None, **kwargs) → ApiResponse

POST smb-share-policies # noqa: E501

Create a new SMB Share policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (SmbSharePolicyPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_share_policies_rules_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE smb-share-policies/rules # noqa: E501

Delete one or more SMB Share policy rules. One of the following is required: ids or names. If names is provided, the policy_ids or policy_names parameter is also required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_rules_delete_with_http_info(x_request_id, context_names, ids, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_smb_share_policies_rules_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET smb-share-policies/rules # noqa: E501

Displays a list of SMB Share policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_rules_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyRuleGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_share_policies_rules_patch_with_http_info(rule: SmbSharePolicyRule, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH smb-share-policies/rules # noqa: E501

Modify an existing SMB Share policy rule. One of the following is required: ids or names. If names is provided, the policy_ids or policy_names parameter is also required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_rules_patch_with_http_info(rule, x_request_id, context_names, ids, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (SmbSharePolicyRule) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

api217_smb_share_policies_rules_post_with_http_info(rule: SmbSharePolicyRulePost, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST smb-share-policies/rules # noqa: E501

Add an SMB Share policy rule. The policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smb_share_policies_rules_post_with_http_info(rule, x_request_id, context_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • rule (SmbSharePolicyRulePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmbSharePolicyRuleResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_snapshot_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_snapshot_api.PoliciesSnapshotApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE policies # noqa: E501

Delete one or more snapshot scheduling policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

DELETE policies/file-system-replica-links # noqa: E501

Remove a snapshot scheduling policy mapped to a file system replica link. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_system_replica_links_delete_with_http_info(x_request_id, context_names, local_file_system_ids, local_file_system_names, member_ids, policy_ids, policy_names, remote_ids, remote_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

GET policies/file-system-replica-links # noqa: E501

List snapshot scheduling policies for file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_system_replica_links_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, local_file_system_ids, local_file_system_names, member_ids, offset, policy_ids, policy_names, remote_file_system_ids, remote_file_system_names, remote_ids, remote_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

  • remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberWithRemoteGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_file_system_replica_links_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST policies/file-system-replica-links # noqa: E501

Add a snapshot scheduling policy to a file system replica link. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_system_replica_links_post_with_http_info(x_request_id, context_names, local_file_system_ids, local_file_system_names, member_ids, policy_ids, policy_names, remote_ids, remote_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberWithRemoteResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_file_system_snapshots_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE policies/file-system-snapshots # noqa: E501

Remove the snapshot scheduling policy mapped to a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_system_snapshots_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_policies_file_system_snapshots_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies/file-system-snapshots # noqa: E501

List file system snapshots mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_system_snapshots_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyFileSystemSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_file_systems_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE policies/file-systems # noqa: E501

Remove the snapshot scheduling policy mapped to a file system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_systems_delete_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_policies_file_systems_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies/file-systems # noqa: E501

List file systems mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_systems_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_file_systems_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST policies/file-systems # noqa: E501

Map a file system to a snapshot scheduling policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_file_systems_post_with_http_info(x_request_id, context_names, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberContextResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies # noqa: E501

Display snapshot scheduling policies and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET policies/members # noqa: E501

List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_members_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, local_file_system_ids, local_file_system_names, member_ids, member_names, member_types, offset, policy_ids, policy_names, remote_file_system_ids, remote_file_system_names, remote_ids, remote_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • member_types (List[str]) – A comma-separated list of member types. Valid values are file-systems, file-system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

  • remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

  • remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberWithRemoteGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_patch_with_http_info(policy: PolicyPatch, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, destroy_snapshots: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH policies # noqa: E501

Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_patch_with_http_info(policy, x_request_id, context_names, destroy_snapshots, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (PolicyPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • destroy_snapshots (bool) – This parameter must be set to true in order to modify a policy such that local or remote snapshots would be destroyed.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[Policy] = None, **kwargs) → ApiResponse

POST policies # noqa: E501

Create a new snapshot scheduling policy with rule attributes to capture file system snapshots for a set period of time and frequency, as well as how long snapshots are retained before being destroyed and eradicated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (Policy) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_ssh_certificate_authority_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_ssh_certificate_authority_api.PoliciesSSHCertificateAuthorityApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_admins_ssh_certificate_authority_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE admins/ssh-certificate-authority-policies # noqa: E501

Remove a SSH Certificate Authority policy from a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_ssh_certificate_authority_policies_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_admins_ssh_certificate_authority_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET admins/ssh-certificate-authority-policies # noqa: E501

List SSH Certificate Authority policies mapped to specific users. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_ssh_certificate_authority_policies_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_admins_ssh_certificate_authority_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST admins/ssh-certificate-authority-policies # noqa: E501

Map a SSH Certificate Authority policy to a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_admins_ssh_certificate_authority_policies_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_ssh_certificate_authority_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE admins/settings/ssh-certificate-authority-policies # noqa: E501

Remove a SSH Certificate Authority policy from being a default for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_ssh_certificate_authority_policies_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_arrays_ssh_certificate_authority_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET admins/settings/ssh-certificate-authority-policies # noqa: E501

List SSH Certificate Authority policies mapped as defaults for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_ssh_certificate_authority_policies_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_arrays_ssh_certificate_authority_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST admins/settings/ssh-certificate-authority-policies # noqa: E501

Map a SSH Certificate Authority policy as a default for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_arrays_ssh_certificate_authority_policies_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_admins_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE ssh-certificate-authority-policies/admins # noqa: E501

Remove a SSH Certificate Authority policy from a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_admins_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_ssh_certificate_authority_policies_admins_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET ssh-certificate-authority-policies/admins # noqa: E501

List SSH Certificate Authority policies mapped to specific users. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_admins_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_admins_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST ssh-certificate-authority-policies/admins # noqa: E501

Map a SSH Certificate Authority policy to a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_admins_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_arrays_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE ssh-certificate-authority-policies/arrays # noqa: E501

Remove a SSH Certificate Authority policy from being a default for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_arrays_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_ssh_certificate_authority_policies_arrays_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET ssh-certificate-authority-policies/arrays # noqa: E501

List SSH Certificate Authority policies mapped as defaults for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_arrays_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_arrays_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST ssh-certificate-authority-policies/arrays # noqa: E501

Map a SSH Certificate Authority policy as a default for admins. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_arrays_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SSH Certificate Authority configurations # noqa: E501

Deletes SSH Certificate Authority configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_ssh_certificate_authority_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List SSH Certificate Authority configurations # noqa: E501

List SSH Certificate Authority configurations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SshCertificateAuthorityPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET ssh-certificate-authority-policies/members # noqa: E501

List SSH Certificate Authority policies mapped to the admin default settings, or to one or more specific users. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_members_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_patch_with_http_info(policy: SshCertificateAuthorityPolicy, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify SSH Certificate Authority configurations # noqa: E501

Modifies one or more attributes of SSH Certificate Authority configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_patch_with_http_info(policy, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (SshCertificateAuthorityPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SshCertificateAuthorityPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_ssh_certificate_authority_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], policy: SshCertificateAuthorityPolicyPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create SSH Certificate Authority configurations # noqa: E501

Creates SSH Certificate Authority configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_ssh_certificate_authority_policies_post_with_http_info(names, policy, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • policy (SshCertificateAuthorityPolicyPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SshCertificateAuthorityPolicyResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_tls_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_tls_api.PoliciesTLSApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_network_interfaces_tls_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE network-interfaces/tls-policies # noqa: E501

Remove a TLS policy from a network interface. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_tls_policies_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_network_interfaces_tls_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET network-interfaces/tls-policies # noqa: E501

List network interface TLS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_tls_policies_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_network_interfaces_tls_policies_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST network-interfaces/tls-policies # noqa: E501

Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_network_interfaces_tls_policies_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete TLS policies # noqa: E501

Deletes TLS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_tls_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, effective: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, purity_defined: Optional[StrictBool] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List TLS policies # noqa: E501

List TLS policies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_get_with_http_info(x_request_id, continuation_token, effective, filter, ids, limit, names, offset, purity_defined, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • effective (bool) – If true, then the TLS policies returned will be fully evaluated. This involves expanding shortened TLS ciphers, removing disabled TLS ciphers from the list of expanded enabled TLS ciphers, and converting values such as default and legacy into concrete values, in order to return the discrete effective TLS settings that the policies encode. Defaults to false.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • purity_defined (bool) – If true, then the results returned will be include the specification for purity-defined values on the current purity version. These values may be used in configurations in order to dynamically adopt new behavior across upgrades, and this option allows the exact behavior for the current version to be returned. Defaults to false.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TlsPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET tls-policies/members # noqa: E501

List TLS policies mapped to the array as a whole, or to one or more specific objects on the array (such as network interfaces). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_members_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_network_interfaces_delete_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE tls-policies/network-interfaces # noqa: E501

Remove a TLS policy from a network interface. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_network_interfaces_delete_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_tls_policies_network_interfaces_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET tls-policies/network-interfaces # noqa: E501

List network interface TLS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_network_interfaces_get_with_http_info(x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_network_interfaces_post_with_http_info(x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST tls-policies/network-interfaces # noqa: E501

Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_network_interfaces_post_with_http_info(x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_patch_with_http_info(policy: TlsPolicy, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify TLS policies # noqa: E501

Modifies one or more attributes of TLS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_patch_with_http_info(policy, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • policy (TlsPolicy) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TlsPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api217_tls_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], policy: TlsPolicyPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create TLS policies # noqa: E501

Creates TLS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_tls_policies_post_with_http_info(names, policy, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • policy (TlsPolicyPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TlsPolicyResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.policies_worm_data_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.policies_worm_data_api.PoliciesWORMDataApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_worm_data_policies_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE worm-data-policies # noqa: E501

Delete a WORM data policy. Deletion is not allowed if the policy is attached to one or more file systems. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_worm_data_policies_delete_with_http_info(x_request_id, context_names, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_worm_data_policies_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET worm-data-policies # noqa: E501

List WORM data policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_worm_data_policies_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(WormDataPoliciesGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_worm_data_policies_members_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET worm-data-policies/members # noqa: E501

List members mapped to a WORM data policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_worm_data_policies_members_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (List[str]) – A comma-separated list of member names.

  • offset (int) – The offset of the first resource to return from a collection.

  • policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (List[str]) – A comma-separated list of policy names.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(WormDataPoliciesMembersGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_worm_data_policies_patch_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[WormDataPolicy] = None, **kwargs) → ApiResponse

PATCH worm-data-policies # noqa: E501

Modify a WORM data policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_worm_data_policies_patch_with_http_info(x_request_id, context_names, ids, names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy (WormDataPolicy) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(WormDataPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

api217_worm_data_policies_post_with_http_info(names: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[WormDataPolicy] = None, **kwargs) → ApiResponse

POST worm-data-policies # noqa: E501

Create a WORM data policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_worm_data_policies_post_with_http_info(names, x_request_id, context_names, policy, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (WormDataPolicy) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(WormDataPoliciesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.public_keys_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.public_keys_api.PublicKeysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_public_keys_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete public key configurations # noqa: E501

Deletes public key configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_public_keys_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_public_keys_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List public key configurations # noqa: E501

List public key configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_public_keys_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PublicKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_public_keys_post_with_http_info(names: ConstrainedListValue[StrictStr], public_key: PublicKeyPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create public key configurations # noqa: E501

Creates public key configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_public_keys_post_with_http_info(names, public_key, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • public_key (PublicKeyPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PublicKeyResponse, status_code(int), headers(HTTPHeaderDict))

api217_public_keys_uses_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET public-keys/uses # noqa: E501

List how public keys are being used and by what. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_public_keys_uses_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PublicKeyUseGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.quotas_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.quotas_api.QuotasApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_quotas_groups_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE quotas/groups # noqa: E501

Delete a hard limit quota for a group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_groups_delete_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, gids, group_names, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_quotas_groups_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET quotas/groups # noqa: E501

List groups with hard limit quotas. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_groups_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, file_system_ids, file_system_names, filter, gids, group_names, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(GroupQuotaGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_groups_patch_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[GroupQuotaPatch] = None, **kwargs) → ApiResponse

PATCH quotas/groups # noqa: E501

Modify a quota for a group. Note that if you modify a group’s quota to a lower value and that group’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_groups_patch_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, gids, group_names, names, quota, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • quota (GroupQuotaPatch) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(GroupQuotaResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_groups_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[GroupQuotaPost] = None, **kwargs) → ApiResponse

POST quotas/groups # noqa: E501

Create a hard limit quota for a group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_groups_post_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, gids, group_names, quota, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • quota (GroupQuotaPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(GroupQuotaResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_settings_get_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET quotas-settings # noqa: E501

List notification attributes of a group or user quota. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_settings_get_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(QuotaSettingGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_settings_patch_with_http_info(quota_setting: QuotaSetting, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH quotas-settings # noqa: E501

Modify the notification attributes of a group or user quota. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_settings_patch_with_http_info(quota_setting, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • quota_setting (QuotaSetting) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(QuotaSettingResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_users_delete_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE quotas/users # noqa: E501

Delete a hard limit file system quota for a user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_users_delete_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, names, uids, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_quotas_users_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET quotas/users # noqa: E501

List users with hard limit file system quotas. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_users_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, file_system_ids, file_system_names, filter, limit, names, offset, sort, uids, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UserQuotaGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_users_patch_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[UserQuotaPatch] = None, **kwargs) → ApiResponse

PATCH quotas/users # noqa: E501

Modify the attributes of a hard limit file system quota. Note that if you modify a user’s quota to a lower value and that user’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_users_patch_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, names, uids, user_names, quota, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • quota (UserQuotaPatch) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UserQuotaResponse, status_code(int), headers(HTTPHeaderDict))

api217_quotas_users_post_with_http_info(x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[UserQuotaPost] = None, **kwargs) → ApiResponse

POST quotas/users # noqa: E501

Create a hard limit file system quota for a user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_quotas_users_post_with_http_info(x_request_id, context_names, file_system_ids, file_system_names, uids, user_names, quota, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • context_names (List[str]) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • quota (UserQuotaPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UserQuotaResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.rdl_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.rdl_api.RDLApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_rapid_data_locking_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Get the status of the Rapid Data Locking feature. # noqa: E501

Displays the status of the Rapid Data Locking feature. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_rapid_data_locking_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RapidDataLockingResponse, status_code(int), headers(HTTPHeaderDict))

api217_rapid_data_locking_patch_with_http_info(rapid_data_locking: RapidDataLocking, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modifies the Rapid Data Locking feature. # noqa: E501

Modifies the Rapid Data Locking feature. Note that the feature can only be enabled if there are no file systems nor buckets created on the array. Once enabled, the feature cannot be modified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_rapid_data_locking_patch_with_http_info(rapid_data_locking, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • rapid_data_locking (RapidDataLocking) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RapidDataLockingResponse, status_code(int), headers(HTTPHeaderDict))

api217_rapid_data_locking_rotate_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Rotates the external keys on the associated EKM appliance. # noqa: E501

Rotates the external keys on the associated EKM appliance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_rapid_data_locking_rotate_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_rapid_data_locking_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Displays Rapid Data Locking test results. # noqa: E501

Displays a detailed result of a Rapid Data Locking test. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_rapid_data_locking_test_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.remote_arrays_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.remote_arrays_api.RemoteArraysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_remote_arrays_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, current_fleet_only: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote arrays # noqa: E501

Lists arrays in the current fleet, as well as arrays that the current array has existing replication connections to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_remote_arrays_get_with_http_info(x_request_id, continuation_token, current_fleet_only, filter, ids, limit, names, offset, sort, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • current_fleet_only (bool) – If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteArraysResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.roles_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.roles_api.RolesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_roles_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET roles # noqa: E501

List roles and permission attributes for role-based access control (RBAC). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_roles_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RoleGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.saml2_sso_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.saml2_sso_api.SAML2SSOApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_sso_saml2_idps_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SAML2 SSO configurations # noqa: E501

Deletes SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_sso_saml2_idps_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List SAML2 SSO configurations # noqa: E501

Displays the SAML2 SSO service provider and identity provider configuration settings in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_saml2_idps_patch_with_http_info(idp: Saml2Sso, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify SAML2 SSO configurations # noqa: E501

Modifies one or more attributes of SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_patch_with_http_info(idp, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • idp (Saml2Sso) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_saml2_idps_post_with_http_info(names: ConstrainedListValue[StrictStr], idp: Saml2SsoPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create SAML2 SSO configurations # noqa: E501

Creates SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_post_with_http_info(names, idp, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • idp (Saml2SsoPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_saml2_idps_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET sso/saml2/idps/test # noqa: E501

Test the existing SAML2 SSO configurations in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_test_get_with_http_info(x_request_id, filter, ids, limit, names, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

api217_sso_saml2_idps_test_patch_with_http_info(idp: Saml2Sso, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH sso/saml2/idps/test # noqa: E501

Modifies and test the provided SAML2 SSO configurations. If the configurations with the specified ids or names exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sso_saml2_idps_test_patch_with_http_info(idp, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • idp (Saml2Sso) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.servers_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.servers_api.ServersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_servers_delete_with_http_info(cascade_delete: ConstrainedListValue[StrictStr], x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE servers # noqa: E501

Delete a server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_servers_delete_with_http_info(cascade_delete, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • cascade_delete (List[str]) – The resource types to delete when deleting this object. It will fail if the resources are referenced by other objects. Valid values include directory-services. (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_servers_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET servers # noqa: E501

List servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_servers_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_servers_patch_with_http_info(server: ServerPost, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH servers # noqa: E501

Modify the server attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_servers_patch_with_http_info(server, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • server (ServerPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_servers_post_with_http_info(create_ds: StrictStr, names: ConstrainedListValue[StrictStr], server: ServerPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST servers # noqa: E501

Add a server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_servers_post_with_http_info(create_ds, names, server, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • create_ds (str) – The name of the directory service object to create used for NFS access to this server. The name must be the server name followed by _nfs. (required)

  • names (List[str]) – A comma-separated list of resource names. (required)

  • server (ServerPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ServerResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.sessions_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.sessions_api.SessionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_sessions_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

List session data # noqa: E501

Displays session data for user login events performed in the Purity//FB GUI, CLI, and REST API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_sessions_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SessionGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.smtp_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.smtp_api.SMTPApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_smtp_servers_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET smtp-servers # noqa: E501

List SMTP server attributes for the array network. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smtp_servers_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmtpServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_smtp_servers_patch_with_http_info(smtp: SmtpServer, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH smtp-servers # noqa: E501

Modify SMTP server attributes such as the relay host and sender domain. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_smtp_servers_patch_with_http_info(smtp, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • smtp (SmtpServer) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmtpServerResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.snmp_agents_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.snmp_agents_api.SNMPAgentsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_snmp_agents_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET snmp-agents # noqa: E501

List SNMP agent attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_agents_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_snmp_agents_mib_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET snmp-agents-mib # noqa: E501

List the SNMP MIB text. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_agents_mib_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentMibResponse, status_code(int), headers(HTTPHeaderDict))

api217_snmp_agents_patch_with_http_info(snmp_agent: SnmpAgent, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH snmp-agents # noqa: E501

Modify SNMP agent attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_agents_patch_with_http_info(snmp_agent, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • snmp_agent (SnmpAgent) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.snmp_managers_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.snmp_managers_api.SNMPManagersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_snmp_managers_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE snmp-managers # noqa: E501

Remove an SNMP manager. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_managers_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_snmp_managers_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET snmp-managers # noqa: E501

List SNMP managers and their attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_managers_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_snmp_managers_patch_with_http_info(snmp_manager: SnmpManager, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH snmp-managers # noqa: E501

Modify SNMP manager attributes such as versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_managers_patch_with_http_info(snmp_manager, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • snmp_manager (SnmpManager) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerResponse, status_code(int), headers(HTTPHeaderDict))

api217_snmp_managers_post_with_http_info(names: ConstrainedListValue[StrictStr], snmp_manager: SnmpManagerPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST snmp-managers # noqa: E501

Create an SNMP manager. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_managers_post_with_http_info(names, snmp_manager, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • snmp_manager (SnmpManagerPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerResponse, status_code(int), headers(HTTPHeaderDict))

api217_snmp_managers_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET snmp-managers/test # noqa: E501

Test if the configuration of an SNMP manager is valid. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_snmp_managers_test_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.software_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.software_api.SoftwareApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_software_check_get_with_http_info(filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software check tasks # noqa: E501

Displays a list of software check tasks. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_software_check_get_with_http_info(filter, ids, limit, names, offset, software_names, software_versions, sort, total_item_count, async_req=True)
>>> result = thread.get()
Parameters

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • software_names (List[str]) – A comma-separated list of software names.

  • software_versions (List[str]) – A comma-separated list of target software versions.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareChecksGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_software_check_post_with_http_info(x_request_id: Optional[StrictStr] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a software check task # noqa: E501

Creates a software check task. To create a task, use a software name and version. If a task is already running, an error is returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_software_check_post_with_http_info(x_request_id, software_names, software_versions, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • software_names (List[str]) – A comma-separated list of software names.

  • software_versions (List[str]) – A comma-separated list of target software versions.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareChecksResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.subnets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.subnets_api.SubnetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_subnets_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE subnets # noqa: E501

Remove an array subnet. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_subnets_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_subnets_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET subnets # noqa: E501

List the array’s subnets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_subnets_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_subnets_patch_with_http_info(subnet: Subnet, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH subnets # noqa: E501

Modify array subnet attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_subnets_patch_with_http_info(subnet, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • subnet (Subnet) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetResponse, status_code(int), headers(HTTPHeaderDict))

api217_subnets_post_with_http_info(names: ConstrainedListValue[StrictStr], subnet: Subnet, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST subnets # noqa: E501

Create an array subnet. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_subnets_post_with_http_info(names, subnet, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • subnet (Subnet) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.support_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.support_api.SupportApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_support_get_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET support # noqa: E501

List Phone Home and Remote Assistance settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_get_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_support_patch_with_http_info(support: Support, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH support # noqa: E501

Modify Phone Home and Remote Assistance settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_patch_with_http_info(support, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • support (Support) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportResponse, status_code(int), headers(HTTPHeaderDict))

api217_support_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, test_type: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET support-test # noqa: E501

Test if the Phone Home and Remote Assistance settings are functioning properly. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_test_get_with_http_info(x_request_id, filter, sort, test_type, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • test_type (str) – Specify the type of test. Valid values are all, phonehome and remote-assist. If not specified, defaults to all.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.support_diagnostics_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.support_diagnostics_api.SupportDiagnosticsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_support_diagnostics_details_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET diagnostics details # noqa: E501

Lists the diagnostics tasks details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_diagnostics_details_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsDetailsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_support_diagnostics_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET diagnostics list # noqa: E501

Lists the support diagnostics tasks. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_diagnostics_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_support_diagnostics_post_with_http_info(x_request_id: Optional[StrictStr] = None, analysis_period_end_time: Optional[ConstrainedIntValue] = None, analysis_period_start_time: Optional[ConstrainedIntValue] = None, **kwargs) → ApiResponse

Start a diagnostic task # noqa: E501

Creates a diagnostics task for a given time interval. If start_time is not provided, defaults to Current System Time - 1 hour. If end_time is not provided, defaults to Current System Time. If a task is already running, an error is returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_diagnostics_post_with_http_info(x_request_id, analysis_period_end_time, analysis_period_start_time, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • analysis_period_end_time (int) – When the analysis time window ends (in milliseconds since epoch).

  • analysis_period_start_time (int) – When the analysis time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.syslog_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.syslog_api.SyslogApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_syslog_servers_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE syslog-servers # noqa: E501

Delete a configured syslog server and stop forwarding syslog messages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_syslog_servers_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET syslog-servers # noqa: E501

Return a list of configured syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_syslog_servers_patch_with_http_info(syslog_server: SyslogServerPatch, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH syslog-servers # noqa: E501

Modify the URI or services of a configured syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_patch_with_http_info(syslog_server, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • syslog_server (SyslogServerPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_syslog_servers_post_with_http_info(syslog_server: SyslogServerPost, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

POST syslog-servers # noqa: E501

Configure a new syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_post_with_http_info(syslog_server, x_request_id, names, async_req=True)
>>> result = thread.get()
Parameters

  • syslog_server (SyslogServerPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api217_syslog_servers_settings_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET syslog-servers/settings # noqa: E501

List the certificate or certificate group associated with the syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_settings_get_with_http_info(x_request_id, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_syslog_servers_settings_patch_with_http_info(syslog_server_settings: SyslogServerSettings, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH syslog-servers/settings # noqa: E501

Modify the certificate or certificate group associated with the syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_settings_patch_with_http_info(syslog_server_settings, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • syslog_server_settings (SyslogServerSettings) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsResponse, status_code(int), headers(HTTPHeaderDict))

api217_syslog_servers_test_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, **kwargs) → ApiResponse

GET syslog-servers/test # noqa: E501

Send test messages to conifgured remote syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_syslog_servers_test_get_with_http_info(x_request_id, continuation_token, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.targets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.targets_api.TargetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_targets_delete_with_http_info(x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

DELETE targets # noqa: E501

Delete the connection to the target for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_targets_delete_with_http_info(x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api217_targets_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET targets # noqa: E501

List targets used for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_targets_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TargetGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_targets_patch_with_http_info(target: Target, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

PATCH targets # noqa: E501

Modify the target attributes for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_targets_patch_with_http_info(target, x_request_id, ids, names, async_req=True)
>>> result = thread.get()
Parameters

  • target (Target) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TargetResponse, status_code(int), headers(HTTPHeaderDict))

api217_targets_performance_replication_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

GET targets/performance/replication # noqa: E501

List replication performance metrics for targets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_targets_performance_replication_get_with_http_info(x_request_id, continuation_token, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_only, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • end_time (int) – When the time window ends (in milliseconds since epoch).

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int) – The offset of the first resource to return from a collection.

  • resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • start_time (int) – When the time window starts (in milliseconds since epoch).

  • total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceReplicationGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_targets_post_with_http_info(names: ConstrainedListValue[StrictStr], target: TargetPost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST targets # noqa: E501

Add a target for replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_targets_post_with_http_info(names, target, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • names (List[str]) – A comma-separated list of resource names. (required)

  • target (TargetPost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TargetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.usage_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.usage_api.UsageApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_usage_groups_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET usage/groups # noqa: E501

List groups with hard limit quotas and their file system usage. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_usage_groups_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, file_system_ids, file_system_names, filter, gids, group_names, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(GroupQuotaGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_usage_users_get_with_http_info(x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

GET usage/users # noqa: E501

List users with hard limit quotas and their file system usage. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_usage_users_get_with_http_info(x_request_id, allow_errors, context_names, continuation_token, file_system_ids, file_system_names, filter, limit, offset, sort, uids, user_names, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_errors (bool) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (List[str]) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UserQuotaGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flashblade.FB_2_17.api.verification_keys_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flashblade.FB_2_17.api.verification_keys_api.VerificationKeysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api217_support_verification_keys_get_with_http_info(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, **kwargs) → ApiResponse

GET verification-keys # noqa: E501

List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_verification_keys_get_with_http_info(x_request_id, continuation_token, filter, limit, offset, sort, async_req=True)
>>> result = thread.get()
Parameters

  • x_request_id (str) – Supplied by client during request or generated by server.

  • continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

  • filter (str) – Exclude resources that don’t match the specified criteria.

  • limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

  • offset (int) – The offset of the first resource to return from a collection.

  • sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VerificationKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api217_support_verification_keys_patch_with_http_info(key: VerificationKeyPatch, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

PATCH verification-keys # noqa: E501

Update the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api217_support_verification_keys_patch_with_http_info(key, x_request_id, async_req=True)
>>> result = thread.get()
Parameters

  • key (VerificationKeyPatch) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VerificationKeyResponse, status_code(int), headers(HTTPHeaderDict))

Module contents

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).

The version of the OpenAPI document: 2.17 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.